Skip to content

test(svelte-query): unify all test descriptions with 'should'#10453

Merged
sukvvon merged 1 commit intomainfrom
test/svelte-query-unify-test-descriptions-with-should
Apr 11, 2026
Merged

test(svelte-query): unify all test descriptions with 'should'#10453
sukvvon merged 1 commit intomainfrom
test/svelte-query-unify-test-descriptions-with-should

Conversation

@sukvvon
Copy link
Copy Markdown
Collaborator

@sukvvon sukvvon commented Apr 11, 2026

🎯 Changes

  • Unify all test descriptions to start with should across 8 svelte-query test files
    • Shouldshould (lowercase): queryOptions.test-d.ts, infiniteQueryOptions.test-d.ts, mutationOptions.test-d.ts
    • Able toshould be able to: createMutation.svelte.test.ts
    • Set correctshould set correct: createMutation.svelte.test.ts
    • Setsshould set: QueryClientProvider.svelte.test.ts
    • Throwshould throw, Do not throwshould not throw: context.svelte.test.ts
    • Runshould run, Can selectshould select: useMutationState.svelte.test.ts
    • handlesshould handle: createQueries.test-d.ts

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Tests
    • Updated test naming conventions across test suites to follow consistent "should..." phrasing for improved clarity and consistency.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b94204e4-f957-48f1-ae7d-68ec6073e3a9

📥 Commits

Reviewing files that changed from the base of the PR and between 6040278 and 97f0138.

📒 Files selected for processing (8)
  • packages/svelte-query/tests/QueryClientProvider/QueryClientProvider.svelte.test.ts
  • packages/svelte-query/tests/context/context.svelte.test.ts
  • packages/svelte-query/tests/createMutation/createMutation.svelte.test.ts
  • packages/svelte-query/tests/createQueries/createQueries.test-d.ts
  • packages/svelte-query/tests/infiniteQueryOptions.test-d.ts
  • packages/svelte-query/tests/mutationOptions/mutationOptions.test-d.ts
  • packages/svelte-query/tests/queryOptions.test-d.ts
  • packages/svelte-query/tests/useMutationState/useMutationState.svelte.test.ts

📝 Walkthrough

Walkthrough

Test case descriptions across multiple test files in the svelte-query package were standardized to follow a consistent naming convention, primarily converting descriptions to lowercase "should..." phrasing. No functional logic, assertions, or control flow were modified.

Changes

Cohort / File(s) Summary
Svelte Component Tests
packages/svelte-query/tests/QueryClientProvider/QueryClientProvider.svelte.test.ts, packages/svelte-query/tests/context/context.svelte.test.ts, packages/svelte-query/tests/createMutation/createMutation.svelte.test.ts, packages/svelte-query/tests/useMutationState/useMutationState.svelte.test.ts
Test descriptions updated to follow consistent "should..." lowercase naming convention.
TypeScript Definition Tests
packages/svelte-query/tests/createQueries/createQueries.test-d.ts, packages/svelte-query/tests/infiniteQueryOptions.test-d.ts, packages/svelte-query/tests/mutationOptions/mutationOptions.test-d.ts, packages/svelte-query/tests/queryOptions.test-d.ts
Test descriptions standardized from capitalized phrasing to lowercase "should..." format across type definition test suites.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Test names now shine so bright,
With "should" in lowercase, just right!
No logic bent, no code refactored,
Just polish—consistency's what we sought. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: unifying test descriptions to use 'should' phrasing across svelte-query test files.
Description check ✅ Passed The description follows the template with complete sections: detailed changes explaining the transformations across 8 files, a fully-checked checklist confirming contributor compliance and local testing, and release impact marked as dev-only with no changeset needed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch test/svelte-query-unify-test-descriptions-with-should

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link
Copy Markdown

nx-cloud bot commented Apr 11, 2026

View your CI Pipeline Execution ↗ for commit 97f0138

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 1m 40s View ↗

☁️ Nx Cloud last updated this comment at 2026-04-11 16:22:17 UTC

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@sukvvon sukvvon self-assigned this Apr 11, 2026
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 11, 2026

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10453

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10453

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10453

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10453

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10453

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10453

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10453

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10453

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10453

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10453

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10453

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10453

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10453

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10453

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10453

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10453

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10453

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10453

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10453

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10453

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10453

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10453

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10453

commit: 97f0138

@github-actions
Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.99 KB (0%)
react minimal 9.02 KB (0%)

@sukvvon sukvvon merged commit 012d323 into main Apr 11, 2026
10 checks passed
@sukvvon sukvvon deleted the test/svelte-query-unify-test-descriptions-with-should branch April 11, 2026 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant